Skip to content

typo react /vue in documentation#9858

Open
martinTabobine wants to merge 1 commit intoTanStack:mainfrom
martinTabobine:patch-1
Open

typo react /vue in documentation#9858
martinTabobine wants to merge 1 commit intoTanStack:mainfrom
martinTabobine:patch-1

Conversation

@martinTabobine
Copy link

@martinTabobine martinTabobine commented Nov 10, 2025 •
edited by coderabbitai bot
Loading

🎯 Changes

In the documentation for vue framework, the exemple in API Reference / QueryClient use import from '@tanstack/react-query' instead of '@tanstack/vuequery'

✅ Checklist

  • X I have followed the steps in the Contributing guide.
  • I have tested this code locally with pnpm run test:pr.

🚀 Release Impact

  • This change affects published code, and I have generated a changeset.
  • X This change is docs/CI/dev-only (no release).

Summary by CodeRabbit

  • Documentation
    • Updated QueryClient reference documentation examples with current library imports.

@changeset-bot
Copy link

changeset-bot bot commented Nov 10, 2025

⚠️ No Changeset found

Latest commit: b5f1d12

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Nov 10, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 10, 2025 •
edited
Loading

Walkthrough

Documentation example updated to import QueryClient from @tanstack/vue-query instead of @tanstack/react-query. The import namespace is corrected to reflect Vue Query usage; no functional logic is modified.

Changes

Cohort / File(s) Change Summary
Documentation Import Update
docs/reference/QueryClient.md		 Import statement changed from @tanstack/react-query to @tanstack/vue-query for correct Vue library reference

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

  • Single import namespace update in documentation with no logic changes
  • No functional impact; documentation accuracy improvement only

Poem

🐰 From React's realm to Vue's bright shore,
An import line found its way home once more,
QueryClient hops to the right package door,
Documentation now shines, clean to the core! ✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately identifies the main change: correcting a React import reference to Vue in the documentation.
Description check ✅ Passed The description follows the template structure with all required sections completed, clearly explaining the Vue documentation import fix and marking it as docs-only.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f7c9526 and b5f1d12.

📒 Files selected for processing (1)
  • docs/reference/QueryClient.md (1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings 
Learnt from: TkDodo
Repo: TanStack/query PR: 9612
File: packages/query-async-storage-persister/src/asyncThrottle.ts:0-0
Timestamp: 2025-09-02T17:57:33.184Z
Learning: When importing from tanstack/query-core in other TanStack Query packages like query-async-storage-persister, a workspace dependency "tanstack/query-core": "workspace:*" needs to be added to the package.json.
📚 Learning: 2025-09-02T17:57:33.184Z 
Learnt from: TkDodo
Repo: TanStack/query PR: 9612
File: packages/query-async-storage-persister/src/asyncThrottle.ts:0-0
Timestamp: 2025-09-02T17:57:33.184Z
Learning: When importing from tanstack/query-core in other TanStack Query packages like query-async-storage-persister, a workspace dependency "tanstack/query-core": "workspace:*" needs to be added to the package.json.

Applied to files:

  • docs/reference/QueryClient.md
🔇 Additional comments (1)
docs/reference/QueryClient.md (1)

11-11: Correct import for Vue Query documentation.

The import statement has been fixed to reference @tanstack/vue-query instead of @tanstack/react-query, ensuring Vue developers copying this example get the correct package import for their framework. The rest of the code example remains valid since QueryClient has the same API across all TanStack Query framework adapters.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@DamianOsipiuk
Copy link
Contributor

DamianOsipiuk commented Nov 13, 2025

This is unfortunately a wrong file to change. We need to create a vue specific override for this page.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@martinTabobine @DamianOsipiuk